Updated API reference docs #168
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull request overview
This PR comprehensively updates the API reference documentation to reflect the current codebase structure, reorganizing the documentation navigation and refreshing content descriptions across all reference pages.
Key changes:
- Added new encoding pipeline documentation (
encoding.md) coveringRTFEncodingEngineandUnifiedRTFEncoder - Reorganized mkdocs.yml navigation to group configuration under Core and move assembly to Utilities
- Updated descriptions across all pages to be more precise and technically accurate
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| mkdocs.yml | Reorganized navigation structure: added encoding pipeline page, moved configuration to Core section, moved assembly helpers to Utilities |
| docs/reference/encoding.md | New page documenting encoding orchestrators for strategy-based pagination and rendering |
| docs/reference/text-formatting.md | Clarified descriptions of text/table attributes and reordered sections for better logical flow |
| docs/reference/tables.md | Updated component descriptions to emphasize spanning, grouping, and pagination features |
| docs/reference/strwidth.md | Focused on get_string_width function with simplified mkdocstrings configuration |
| docs/reference/rtf-document.md | Refreshed entry-point description to emphasize unified encoding pipeline |
| docs/reference/pagination.md | Expanded coverage to include contexts, strategy registry, built-in strategies, and page feature processor |
| docs/reference/page-layout.md | Added RTFSubline component and clarified header/footer/title descriptions |
| docs/reference/low-level.md | Retitled to "Core utilities" and added RTFDefaults documentation |
| docs/reference/convert.md | Simplified to focus on LibreOfficeConverter with cleaner mkdocstrings block |
| docs/reference/assemble.md | Changed to document each assembly function with individual mkdocstrings blocks |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
elong0527
approved these changes
Dec 8, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #167
This PR updates
mkdocs.ymland the API reference docs to mirror the current codebase:docs/reference/rtf-document.mdrefreshes the entry-point description, and a newdocs/reference/encoding.mddocumentsRTFEncodingEngine/UnifiedRTFEncoder.docs/reference/page-layout.mdnow includesRTFSublineand refreshed copy for headers/footers/titles; table/text utility pages were tightened up and clarified.docs/reference/pagination.mdcovers the metadata-driven contexts, strategy registry, built-in strategies, and page feature processor.docs/reference/low-level.md,convert.md,assemble.md, andstrwidth.mdnow emphasize configuration/defaults, conversion/assembly helpers, and string width with consistent mkdocstrings blocks.mkdocs.ymlreorganized to add the encoding page, move configuration into Core, and move assembly under Utilities.